Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[21114] Remove doxygen warnings (#4700, #5011) #5016

Merged
merged 2 commits into from
Jul 3, 2024
Merged

[21114] Remove doxygen warnings (#4700, #5011) #5016

merged 2 commits into from
Jul 3, 2024

Conversation

EduPonz
Copy link

@EduPonz EduPonz commented Jul 2, 2024 •
edited
Loading

Description

This PR is a manual backport to 2.14.x of two PRs:

This work has been done so the following docs PR passes CI:

Related PRs:

@Mergifyio backport 2.13.x 2.10.x

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • N/A: Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
  • Any new/modified methods have been properly documented using Doxygen.
  • N/A: Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.
  • Changes are API compatible.
  • N/A: New feature has been added to the versions.md file (if applicable).
  • New feature has been documented/Current behavior is correctly described in the documentation.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • N/A: If this is a critical bug fix, backports to the critical-only supported branches have been requested.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

@EduPonz
Refs #21114: Remove doxygen warnings
f9f36ce 
Signed-off-by: eduponz <eduardoponz@eprosima.com>
@EduPonz EduPonz added this to the v2.14.3 milestone Jul 2, 2024
This was referenced Jul 2, 2024
Merged
Merged
@EduPonz EduPonz added no-test Skip CI tests if PR marked with this label labels Jul 2, 2024
@github-actions github-actions bot added the ci-pending PR which CI is running label Jul 2, 2024
MiguelCompany
MiguelCompany requested changes Jul 2, 2024
View reviewed changes
include/fastdds/dds/domain/DomainParticipantListener.hpp Outdated Show resolved Hide resolved
include/fastdds/rtps/common/Types.h Outdated Show resolved Hide resolved
@EduPonz EduPonz added skip-ci Automatically pass CI and removed no-test Skip CI tests if PR marked with this label labels Jul 3, 2024
@EduPonz
Refs #21114: Apply Miguel's suggestions
ff2994a 
Signed-off-by: eduponz <eduardoponz@eprosima.com>
@EduPonz EduPonz merged commit 28a2e15 into 2.14.x Jul 3, 2024
3 checks passed
@EduPonz EduPonz deleted the mergify/bp/2.14.x/pr-795 branch July 3, 2024 05:28
@EduPonz
Copy link
Author

EduPonz commented Jul 3, 2024

@Mergifyio backport 2.13.x 2.10.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Jul 3, 2024 •
edited
Loading

backport 2.13.x 2.10.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @mergify
Remove doxygen warnings (#4700, #5011) (#5016)
2e796db 
* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/dds/publisher/Publisher.hpp
#	include/fastdds/dds/subscriber/Subscriber.hpp
@mergify mergify bot mentioned this pull request Jul 3, 2024
Merged
12 tasks
mergify bot pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @mergify
Remove doxygen warnings (#4700, #5011) (#5016)
632f543 
* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/dds/publisher/Publisher.hpp
#	include/fastdds/dds/subscriber/Subscriber.hpp
This was referenced Jul 3, 2024
Merged
Merged
Open
@EduPonz EduPonz mentioned this pull request Jul 3, 2024
Merged
8 tasks
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @JesusPoderoso
Remove doxygen warnings (#4700, #5011) (#5016)
82be21b 
* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/dds/publisher/Publisher.hpp
#	include/fastdds/dds/subscriber/Subscriber.hpp
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @JesusPoderoso
Remove doxygen warnings (#4700, #5011) (#5016)
d488cfd 
* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/dds/publisher/Publisher.hpp
#	include/fastdds/dds/subscriber/Subscriber.hpp
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz
Remove doxygen warnings (#4700, #5011) (#5016) (#5024)
a886cff 
* Remove doxygen warnings (#4700, #5011) (#5016)

* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

# Conflicts:
#	include/fastdds/dds/core/policy/QosPolicies.hpp
#	include/fastdds/dds/publisher/Publisher.hpp
#	include/fastdds/dds/subscriber/Subscriber.hpp
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

* Adjust doxygen so Fast DDS Python pydoc makes RTD build (#5026)

* Refs #21114: Fix dispose

Signed-off-by: eduponz <eduardoponz@eprosima.com>

Refs #21114: Split return into several @return

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix register_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix unregister_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix read_next_instance_w_condition

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_w_condition

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_next_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_next_instance_w_condition

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@EduPonz
Remove doxygen warnings (#4700, #5011) (#5016)
572851a 
* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz
Remove doxygen warnings (#4700, #5011) (#5016) (#5025)
0e4e234 
* Remove doxygen warnings (#4700, #5011) (#5016)

* Refs #21114: Remove doxygen warnings

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Apply Miguel's suggestions

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 28a2e15)

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Adjust doxygen so Fast DDS Python pydoc makes RTD build (#5026)

* Refs #21114: Fix dispose

Signed-off-by: eduponz <eduardoponz@eprosima.com>

Refs #21114: Split return into several @return

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix register_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix unregister_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix read_next_instance_w_condition

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_w_condition

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_next_instance

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix take_next_instance_w_condition

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MiguelCompany MiguelCompany MiguelCompany approved these changes

Assignees
No one assigned
Labels
ci-pending PR which CI is running skip-ci Automatically pass CI
Projects
None yet
Milestone
v2.14.3
Development

Successfully merging this pull request may close these issues.
2 participants
@EduPonz @MiguelCompany